<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkFileFilter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="prev" href="GtkFileChooserWidget.html" title="GtkFileChooserWidget">
<link rel="next" href="GtkFontButton.html" title="GtkFontButton">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="Builder.html" title="Interface builder">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="chapter" href="gtk-migrating-GtkBuilder.html" title="Migrating from libglade to GtkBuilder">
<link rel="chapter" href="gtk-migrating-tooltips.html" title="Migrating from GtkTooltips to GtkTooltip">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="api-index-full.html" title="Index of all symbols">
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
<link rel="index" href="api-index-2-2.html" title="Index of new symbols in 2.2">
<link rel="index" href="api-index-2-4.html" title="Index of new symbols in 2.4">
<link rel="index" href="api-index-2-6.html" title="Index of new symbols in 2.6">
<link rel="index" href="api-index-2-8.html" title="Index of new symbols in 2.8">
<link rel="index" href="api-index-2-10.html" title="Index of new symbols in 2.10">
<link rel="index" href="api-index-2-12.html" title="Index of new symbols in 2.12">
<link rel="index" href="api-index-2-14.html" title="Index of new symbols in 2.14">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkFileChooserWidget.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="SelectorWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkFontButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtk-gtkfilefilter.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#gtk-gtkfilefilter.description" class="shortcut">Description</a>
                 | 
                <a href="#gtk-gtkfilefilter.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="gtk-gtkfilefilter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk-gtkfilefilter.top_of_page"></a>GtkFileFilter</span></h2>
<p>GtkFileFilter — A filter for selecting a file subset</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gtk-gtkfilefilter.synopsis"></a><h2>Synopsis</h2>
<a name="GtkFileFilter"></a><pre class="synopsis">

#include &lt;gtk/gtk.h&gt;

                    <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter-struct" title="GtkFileFilter">GtkFileFilter</a>;
                    <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo">GtkFileFilterInfo</a>;
enum                <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a>;
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()">*GtkFileFilterFunc</a>)                (const <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *     <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-new" title="gtk_file_filter_new ()">gtk_file_filter_new</a>                 (void);
void                <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-set-name" title="gtk_file_filter_set_name ()">gtk_file_filter_set_name</a>            (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *       <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-get-name" title="gtk_file_filter_get_name ()">gtk_file_filter_get_name</a>            (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);
void                <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-mime-type" title="gtk_file_filter_add_mime_type ()">gtk_file_filter_add_mime_type</a>       (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);
void                <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-pattern" title="gtk_file_filter_add_pattern ()">gtk_file_filter_add_pattern</a>         (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *pattern);
void                <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-pixbuf-formats" title="gtk_file_filter_add_pixbuf_formats ()">gtk_file_filter_add_pixbuf_formats</a>  (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);
void                <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()">gtk_file_filter_add_custom</a>          (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a> needed,
                                                         <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()">GtkFileFilterFunc</a> func,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"
>GDestroyNotify</a> notify);
<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a>  <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-get-needed" title="gtk_file_filter_get_needed ()">gtk_file_filter_get_needed</a>          (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()">gtk_file_filter_filter</a>              (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="gtk-gtkfilefilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
               +----GtkFileFilter
</pre>
</div>
<div class="refsect1" lang="en">
<a name="gtk-gtkfilefilter.description"></a><h2>Description</h2>
<p>
A GtkFileFilter can be used to restrict the files being shown
in a <a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>. Files can be filtered based on their name
(with <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-pattern" title="gtk_file_filter_add_pattern ()"><code class="function">gtk_file_filter_add_pattern()</code></a>), on their mime type (with
<a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-mime-type" title="gtk_file_filter_add_mime_type ()"><code class="function">gtk_file_filter_add_mime_type()</code></a>), or by a custom filter function
(with <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>).
</p>
<p>
Filtering by mime types handles aliasing and subclassing of mime
types; e.g. a filter for text/plain also matches a file with mime
type application/rtf, since application/rtf is a subclass of
text/plain. Note that <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> allows wildcards for the
subtype of a mime type, so you can e.g. filter for image/*.
</p>
<p>
Normally, filters are used by adding them to a <a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>,
see <a class="link" href="GtkFileChooser.html#gtk-file-chooser-add-filter" title="gtk_file_chooser_add_filter ()"><code class="function">gtk_file_chooser_add_filter()</code></a>, but it is also possible
to manually use a filter on a file with <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="gtk-gtkfilefilter.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GtkFileFilter-struct"></a><h3>GtkFileFilter</h3>
<pre class="programlisting">typedef struct _GtkFileFilter GtkFileFilter;</pre>
<p>
The <span class="structname">GtkFileFilter</span> struct contains
only private fields and should not be directly accessed.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkFileFilterInfo"></a><h3>GtkFileFilterInfo</h3>
<pre class="programlisting">typedef struct {
  GtkFileFilterFlags contains;

  const gchar *filename;
  const gchar *uri;
  const gchar *display_name;
  const gchar *mime_type;
} GtkFileFilterInfo;
</pre>
<p>
A <span class="structname">GtkFileFilterInfo</span> struct is used
to pass information about the tested file to
<a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a> <em class="structfield"><code>contains</code></em>;</span></p></td>
<td>Flags indicating which of the following fields need
  are filled
</td>
</tr>
<tr>
<td><p><span class="term">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>filename</code></em>;</span></p></td>
<td>the filename of the file being tested
</td>
</tr>
<tr>
<td><p><span class="term">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>uri</code></em>;</span></p></td>
<td>the URI for the file being tested
</td>
</tr>
<tr>
<td><p><span class="term">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>display_name</code></em>;</span></p></td>
<td>the string that will be used to display the file
  in the file chooser
</td>
</tr>
<tr>
<td><p><span class="term">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>mime_type</code></em>;</span></p></td>
<td>the mime type of the file
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkFileFilterFlags"></a><h3>enum GtkFileFilterFlags</h3>
<pre class="programlisting">typedef enum {
  GTK_FILE_FILTER_FILENAME     = 1 &lt;&lt; 0,
  GTK_FILE_FILTER_URI          = 1 &lt;&lt; 1,
  GTK_FILE_FILTER_DISPLAY_NAME = 1 &lt;&lt; 2,
  GTK_FILE_FILTER_MIME_TYPE    = 1 &lt;&lt; 3
} GtkFileFilterFlags;
</pre>
<p>
These flags indicate what parts of a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> struct
are filled or need to be filled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GTK-FILE-FILTER-FILENAME--CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_FILENAME</code></span></p></td>
<td>the filename of the file being tested
</td>
</tr>
<tr>
<td><p><a name="GTK-FILE-FILTER-URI--CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_URI</code></span></p></td>
<td>the URI for the file being tested
</td>
</tr>
<tr>
<td><p><a name="GTK-FILE-FILTER-DISPLAY-NAME--CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_DISPLAY_NAME</code></span></p></td>
<td>the string that will be used to 
  display the file in the file chooser
</td>
</tr>
<tr>
<td><p><a name="GTK-FILE-FILTER-MIME-TYPE--CAPS"></a><span class="term"><code class="literal">GTK_FILE_FILTER_MIME_TYPE</code></span></p></td>
<td>the mime type of the file
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkFileFilterFunc"></a><h3>GtkFileFilterFunc ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            (*GtkFileFilterFunc)                (const <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
The type of function that is used with custom filters,
see <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter_info</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> that is filled according
  to the <em class="parameter"><code>needed</code></em> flags passed to <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data passed to <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>%TRUE if the file should be displayed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-new"></a><h3>gtk_file_filter_new ()</h3>
<pre class="programlisting"><a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *     gtk_file_filter_new                 (void);</pre>
<p>
Creates a new <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a> with no rules added to it.
Such a filter doesn't accept any files, so is not
particularly useful until you add rules with
<a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-mime-type" title="gtk_file_filter_add_mime_type ()"><code class="function">gtk_file_filter_add_mime_type()</code></a>, <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-pattern" title="gtk_file_filter_add_pattern ()"><code class="function">gtk_file_filter_add_pattern()</code></a>,
or <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-add-custom" title="gtk_file_filter_add_custom ()"><code class="function">gtk_file_filter_add_custom()</code></a>. To create a filter
that accepts any file, use:
</p>
<div class="informalexample"><pre class="programlisting">
GtkFileFilter *filter = gtk_file_filter_new ();
gtk_file_filter_add_pattern (filter, "*");
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>

</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-set-name"></a><h3>gtk_file_filter_set_name ()</h3>
<pre class="programlisting">void                gtk_file_filter_set_name            (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Sets the human-readable name of the filter; this is the string
that will be displayed in the file selector user interface if
there is a selectable list of filters.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the human-readable-name for the filter, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>
  to remove any existing name.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-get-name"></a><h3>gtk_file_filter_get_name ()</h3>
<pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *       gtk_file_filter_get_name            (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);</pre>
<p>
Gets the human-readable name for the filter. See <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-set-name" title="gtk_file_filter_set_name ()"><code class="function">gtk_file_filter_set_name()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The human-readable name of the filter,
  or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>. This value is owned by GTK+ and must not
  be modified or freed.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-add-mime-type"></a><h3>gtk_file_filter_add_mime_type ()</h3>
<pre class="programlisting">void                gtk_file_filter_add_mime_type       (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);</pre>
<p>
Adds a rule allowing a given mime type to <em class="parameter"><code>filter</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> A <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
<td> name of a MIME type
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-add-pattern"></a><h3>gtk_file_filter_add_pattern ()</h3>
<pre class="programlisting">void                gtk_file_filter_add_pattern         (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *pattern);</pre>
<p>
Adds a rule allowing a shell style glob to a filter.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pattern</code></em> :</span></p></td>
<td> a shell style glob
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-add-pixbuf-formats"></a><h3>gtk_file_filter_add_pixbuf_formats ()</h3>
<pre class="programlisting">void                gtk_file_filter_add_pixbuf_formats  (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);</pre>
<p>
Adds a rule allowing image files in the formats supported
by GdkPixbuf.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.6</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-add-custom"></a><h3>gtk_file_filter_add_custom ()</h3>
<pre class="programlisting">void                gtk_file_filter_add_custom          (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a> needed,
                                                         <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFunc" title="GtkFileFilterFunc ()">GtkFileFilterFunc</a> func,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"
>GDestroyNotify</a> notify);</pre>
<p>
Adds rule to a filter that allows files based on a custom callback
function. The bitfield <em class="parameter"><code>needed</code></em> which is passed in provides information
about what sorts of information that the filter function needs;
this allows GTK+ to avoid retrieving expensive information when
it isn't needed by the filter.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>needed</code></em> :</span></p></td>
<td> bitfield of flags indicating the information that the custom
         filter function needs.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td> callback function; if the function returns <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a>, then
  the file will be displayed.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> data to pass to <em class="parameter"><code>func</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
<td> function to call to free <em class="parameter"><code>data</code></em> when it is no longer needed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-get-needed"></a><h3>gtk_file_filter_get_needed ()</h3>
<pre class="programlisting"><a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterFlags" title="enum GtkFileFilterFlags">GtkFileFilterFlags</a>  gtk_file_filter_get_needed          (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter);</pre>
<p>
Gets the fields that need to be filled in for the structure
passed to <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a>
</p>
<p>
This function will not typically be used by applications; it
is intended principally for use in the implementation of
<a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> bitfield of flags indicating needed fields when
  calling <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-filter" title="gtk_file_filter_filter ()"><code class="function">gtk_file_filter_filter()</code></a>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-file-filter-filter"></a><h3>gtk_file_filter_filter ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            gtk_file_filter_filter              (<a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter">GtkFileFilter</a> *filter,
                                                         const <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo">GtkFileFilterInfo</a> *filter_info);</pre>
<p>
Tests whether a file should be displayed according to <em class="parameter"><code>filter</code></em>.
The <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> structure <em class="parameter"><code>filter_info</code></em> should include
the fields returned from <a class="link" href="gtk-gtkfilefilter.html#gtk-file-filter-get-needed" title="gtk_file_filter_get_needed ()"><code class="function">gtk_file_filter_get_needed()</code></a>.
</p>
<p>
This function will not typically be used by applications; it
is intended principally for use in the implementation of
<a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilter"><span class="type">GtkFileFilter</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter_info</code></em> :</span></p></td>
<td> a <a class="link" href="gtk-gtkfilefilter.html#GtkFileFilterInfo" title="GtkFileFilterInfo"><span class="type">GtkFileFilterInfo</span></a> structure containing information
 about a file.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> if the file should be displayed

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="gtk-gtkfilefilter.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>
